<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Struct bmqt::UriParser</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqt.html">bmqt</a>      </li>
      <li><a class="el" href="structbmqt_1_1UriParser.html">bmqt::UriParser</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>bmqt::UriParser Struct Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqt::UriParser" -->
<p><code>#include &lt;<a class="el" href="bmqt__uri_8h_source.html">bmqt_uri.h</a>&gt;</code></p>

<p><a href="structbmqt_1_1UriParser-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1UriParser.html#a636751d810309e8335df0c8615ada41a">initialize</a> (bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1UriParser.html#a6bcf2efcf00834062adc1b02f0acc38d">shutdown</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1UriParser.html#a688ab161aebc54ecac04aba0ce13a373">parse</a> (<a class="el" href="classbmqt_1_1Uri.html">Uri</a> *result, bsl::string *errorDescription, const bslstl::StringRef &amp;uriString)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Utility namespace of methods for parsing URI strings into <code><a class="el" href="classbmqt_1_1Uri.html">Uri</a></code> objects.</p>
<p>See <a class="el" href="group__bmqt__uri.html">Component bmqt_uri</a> </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a636751d810309e8335df0c8615ada41a"></a><!-- doxytag: member="bmqt::UriParser::initialize" ref="a636751d810309e8335df0c8615ada41a" args="(bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void bmqt::UriParser::initialize </td>
          <td>(</td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initialize the <code><a class="el" href="structbmqt_1_1UriParser.html">UriParser</a></code>. Note that this will compile the regular expression used by <code>parseUri</code>. This method only needs to be called once before any other method, but can be called multiple times provided that for each call to <code>initialize</code> there is a corresponding call to <code>shutdown</code>. Use the optionally specified <code>allocator</code> for any memory allocation, or the <code>global</code> allocator if none is provided. Note that specifying the allocator is provided for test drivers only, and therefore users should let it default to the global allocator. </p>

</div>
</div>
<a class="anchor" id="a6bcf2efcf00834062adc1b02f0acc38d"></a><!-- doxytag: member="bmqt::UriParser::shutdown" ref="a6bcf2efcf00834062adc1b02f0acc38d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void bmqt::UriParser::shutdown </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Pendant operation of the <code>initialize</code> one. Note that behaviour after calling the <code>.<a class="el" href="structbmqt_1_1UriParser.html#a688ab161aebc54ecac04aba0ce13a373">parse()</a></code> method of the <code><a class="el" href="structbmqt_1_1UriParser.html">UriParser</a></code> after <code>shutdown</code> has been called is undefined. The number of calls to <code>shutdown</code> must equal the number of calls to <code>initialize</code>, without corresponding <code>shutdown</code> calls, to fully destroy the parser. It is safe to call <code>initialize</code> after calling <code>shutdown</code>. Behaviour is undefined if <code>shutdown</code> is called without <code>initialize</code> first being called. </p>

</div>
</div>
<a class="anchor" id="a688ab161aebc54ecac04aba0ce13a373"></a><!-- doxytag: member="bmqt::UriParser::parse" ref="a688ab161aebc54ecac04aba0ce13a373" args="(Uri *result, bsl::string *errorDescription, const bslstl::StringRef &amp;uriString)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int bmqt::UriParser::parse </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classbmqt_1_1Uri.html">Uri</a> *&nbsp;</td>
          <td class="paramname"> <em>result</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bsl::string *&nbsp;</td>
          <td class="paramname"> <em>errorDescription</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const bslstl::StringRef &amp;&nbsp;</td>
          <td class="paramname"> <em>uriString</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Parse the specified <code>uriString</code> into the specified <code>result</code> object if <code>uriString</code> is a valid URI, otherwise load the specified <code>errorDescription</code> with a description of the syntax error present in <code>uriString</code>. Return 0 on success and non-zero if <code>uriString</code> does not have a valid syntax. Note that <code>errorDescription</code> may be null if the caller does not care about getting error messages. The behavior is undefined unless <code>initialize</code> has been called previously. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bmqt__uri_8h_source.html">bmqt_uri.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:52 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
